home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 21 / AACD 21.iso / AACD / Programming / Scalos / Developer / Autodoc / scalosAPI.doc < prev   
Encoding:
Text File  |  2000-06-01  |  5.4 KB  |  324 lines
  1. TABLE OF CONTENTS
  2.  
  3. scalosAPI/--background
  4. scalosAPI/--Scalos_Message
  5. scalosAPI/--Modules
  6. scalosAPI/--PlugIn's
  7. scalosAPI/--MenuPlugIn's
  8. scalosAPI/MTYP_CloseWindow
  9. scalosAPI/MTYP_NewPattern
  10. scalosAPI/MTYP_Sleep
  11. scalosAPI/MTYP_Wakeup
  12. scalosAPI/MTYP_AppSleep
  13. scalosAPI/MTYP_AppWakeup
  14. scalosAPI/MTYP_Redraw
  15. scalosAPI/MTYP_Update
  16. scalosAPI/MTYP_UpdateIcon
  17. scalosAPI/MTYP_AddIcon
  18. scalosAPI/MTYP_RemIcon
  19. scalosAPI/MTYP_Iconify
  20. scalosAPI/MTYP_UnIconify
  21.  
  22.  
  23. --background
  24. This documentation gives you information how to comunicate with Scalos and
  25. its windowtasks. There are not many MessageTypes currently available, but it
  26. will be more in future.
  27.  
  28.  
  29. --Scalos_Message
  30. If you send a message to scalos you should use the SCA_AllocMessage and SCA_Free-
  31. Message calls from the scalos.library. The returned message will look like
  32. this:
  33.     struct ScalosMessage
  34.     {
  35.         struct Message    ExecMessage;
  36.         ULONG        Signature;    /* "IMSG" */
  37.         ULONG        MessageType;
  38.     };
  39. The messageports where to send the messages to are available via the SCA_Lock-
  40. WindowList/SCA_UnLockWindowList calls from scalos.library.
  41.  
  42. Additional data depends on the MessageType. Synopsis will give you information
  43. about this data. Inputs means the message for PutMsg and Result the one that
  44. was replied.
  45.  
  46.  
  47. --Modules
  48. Modules are programs with a standard wb-start enviroment. The arguments are
  49. additional values (e.g. Execute_Command: the dir and the filename as default
  50. value for the string-gadget)
  51.  
  52.  
  53. --PlugIn's
  54. PlugIn's are external BOOPSI Classes that will enhance or replace internal
  55. classes. The only thing you have to do is to write a little library with
  56. only on offset. This one has to return a ClassInfo struct. Your PlugIn can
  57. be added automatically on startup if you add it to the PlugIn list in Scalos
  58. Prefs.
  59.  
  60.     SYNOPSIS
  61.     ClassInfo GetClassInfo()
  62.         D0
  63.  
  64.     struct ClassInfo GetClassInfo( void );
  65.  
  66.  
  67. --MenuPlugIn's
  68. A MenuPlugIn is a little library with one function. This function have to be
  69. full reentrant. The windowtask is blocked until your function returns. Never
  70. open a requester or block the task for a long time use SCCM_AsyncRoutine
  71. instead.
  72.  
  73.     SYNOPSIS
  74.     MenuFunction( WindowTask, IconNode)
  75.                      A0          A1
  76.  
  77.     void MenuFunction( struct WindowTask, struct IconNode );
  78.  
  79.  
  80.     NAME
  81.     MTYP_CloseWindow
  82.  
  83.     SYNOPSIS
  84.  
  85.     FUNCTION
  86.     Closes the window of the selected messageport.
  87.  
  88.     INPUTS
  89.  
  90.     RESULT
  91.  
  92.     SEE ALSO
  93.  
  94.  
  95.     NAME
  96.     MTYP_NewPattern
  97.  
  98.     SYNOPSIS
  99.     APTR PatternNode
  100.  
  101.     FUNCTION
  102.     Sets a new pattern for the window
  103.  
  104.     INPUTS
  105.     PatternNode - the new pattern or NULL for no pattern.
  106.  
  107.     RESULT
  108.  
  109.     SEE ALSO
  110.  
  111.  
  112.     NAME
  113.     MTYP_Sleep
  114.  
  115.     SYNOPSIS
  116.  
  117.     FUNCTION
  118.     The windowtask that receives this message will be sleep. Only the
  119.     window will be closed, no icon will be displayed.
  120.  
  121.     INPUTS
  122.  
  123.     RESULT
  124.  
  125.     NOTE
  126.     Never send this message to a the main_messageport!
  127.  
  128.     SEE ALSO
  129.  
  130.  
  131.     NAME
  132.     MTYP_Wakeup
  133.  
  134.     SYNOPSIS
  135.     ULONG    ReLayout
  136.  
  137.     FUNCTION
  138.     Wakeup the selected window_task. It's the opposite to MTYP_Sleep.
  139.  
  140.     INPUTS
  141.     ReLayout - BOOL - TRUE if all icons of the window should be relayouted
  142.  
  143.     RESULT
  144.  
  145.     NOTE
  146.     Never send this message to a the main_messageport!
  147.  
  148.     SEE ALSO
  149.  
  150.  
  151.     NAME
  152.     MTYP_AppSleep
  153.  
  154.     SYNOPSIS
  155.  
  156.     FUNCTION
  157.     All windowtasks and all ScalosApplications will fall
  158.     asleep.
  159.  
  160.     INPUTS
  161.  
  162.     RESULT
  163.  
  164.     NOTE
  165.     This message must be sent to the main_messageport!
  166.  
  167.     SEE ALSO
  168.  
  169.  
  170.     NAME
  171.     MTYP_AppWakeup
  172.  
  173.     SYNOPSIS
  174.     ULONG    ReLayout
  175.  
  176.     FUNCTION
  177.     Wakeup all thing that sleeps since MTYP_AppSleep.
  178.  
  179.     INPUTS
  180.     ReLayout - BOOL - TRUE if all icons should be relayouted
  181.  
  182.     RESULT
  183.  
  184.     NOTE
  185.     This message must be sent to the main_messageport!
  186.  
  187.     SEE ALSO
  188.  
  189.  
  190.     NAME
  191.     MTYP_Redraw
  192.  
  193.     SYNOPSIS
  194.     ULONG    Flags
  195.  
  196.     FUNCTION
  197.     Redraws the icons inside of the window. This method could be uses to
  198.     refresh the window after adding or selecting/deselecting icons.
  199.  
  200.     INPUTS
  201.     Flags - 
  202.         DontClearBG - if you like that the window should clear
  203.                       its background first set this to FALSE
  204.         ReLayout - Rerender the layout of the icons
  205.  
  206.     RESULT
  207.  
  208.     SEE ALSO
  209.  
  210.  
  211.     NAME
  212.     MTYP_Update
  213.  
  214.     SYNOPSIS
  215.  
  216.     FUNCTION
  217.     Causes the window to reread its icons.
  218.  
  219.     INPUTS
  220.  
  221.     RESULT
  222.  
  223.     SEE ALSO
  224.  
  225.  
  226.     NAME
  227.     MTYP_UpdateIcon
  228.  
  229.     SYNOPSIS
  230.     struct UpdateIcon
  231.  
  232.     FUNCTION
  233.     Refresh a selected icon.
  234.  
  235.     INPUTS
  236.     UpdateIcon - WindowType specific data
  237.  
  238.     RESULT
  239.  
  240.     NOTE
  241.     SCA_AllocMessage() does not allocate the UpdateIcon structure!
  242.  
  243.     SEE ALSO
  244.     scalos.library/UpdateIcon
  245.  
  246.     NAME
  247.     MTYP_AddIcon
  248.  
  249.     SYNOPSIS
  250.     UWORD x
  251.     UWORD y
  252.     struct UpdateIcon
  253.  
  254.     FUNCTION
  255.     Causes a window task to load a selected icon.
  256.  
  257.     INPUTS
  258.     x,y - the position where the icon should appear or 0x8000 for any
  259.     UpdateIcon - WindowType specific data
  260.  
  261.     RESULT
  262.  
  263.     NOTE
  264.     SCA_AllocMessage() does not allocate the UpdateIcon structure!
  265.  
  266.     SEE ALSO
  267.  
  268.  
  269.     NAME
  270.     MTYP_RemIcon
  271.  
  272.     SYNOPSIS
  273.     struct UpdateIcon
  274.  
  275.     FUNCTION
  276.     Removes an icon from window.
  277.  
  278.     INPUTS
  279.     UpdateIcon - WindowType specific data
  280.  
  281.     RESULT
  282.  
  283.     NOTE
  284.     SCA_AllocMessage() does not allocate the UpdateIcon structure!
  285.  
  286.     SEE ALSO
  287.  
  288.  
  289.     NAME
  290.     MTYP_Iconify
  291.  
  292.     SYNOPSIS
  293.  
  294.     FUNCTION
  295.     Set the window to sleep and adds an icon to the main window.
  296.  
  297.     INPUTS
  298.  
  299.     NOTE
  300.     Never send this message to the main window!
  301.  
  302.     RESULT
  303.  
  304.     SEE ALSO
  305.  
  306.  
  307.     NAME
  308.     MTYP_UnIconify
  309.  
  310.     SYNOPSIS
  311.  
  312.     FUNCTION
  313.     Removes the appicon from main window and reopens the window.
  314.  
  315.     INPUTS
  316.  
  317.     RESULT
  318.  
  319.     NOTE
  320.     Never send this message to the main window!
  321.  
  322.     SEE ALSO
  323.  
  324.